gh-130160: use `.. program::` directive for documenting `idle` CLI by Mr-Sunglasses · Pull Request #130278 · python/cpython

Mr-Sunglasses · 2025-02-18T17:21:09Z

Issue: Use .. program:: and .. option:: directives for modules with a documented CLI #130160

📚 Documentation preview 📚: https://cpython-previews--130278.org.readthedocs.build/

StanFromIreland · 2025-02-19T14:22:26Z

I don't think we can use these here because of how help.py for idle is generated. This may destroy the nice indentation we currently have?

New

Old

Also please run idlelib.help.copy_strip() so that help.html is updated.

terryjreedy

Make changes, but I will want to review some of the other explanation lines before merging.

Doc/library/idle.rst

bedevere-app · 2025-02-20T07:58:37Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Mr-Sunglasses · 2025-02-21T14:54:05Z

I have made the requested changes; please review again.

bedevere-app · 2025-02-21T14:54:11Z

Thanks for making the requested changes!

@terryjreedy: please review the changes made to this pull request.

Doc/library/idle.rst

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

Doc/library/idle.rst

Split long line. Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Emphasize *options*. Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

Satisfied with changes.

miss-islington-app · 2025-02-24T02:02:41Z

Thanks @Mr-Sunglasses for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

…CLI (pythonGH-130278) --------- Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> (cherry picked from commit 0ff1611) Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>

bedevere-app · 2025-02-24T02:02:49Z

GH-130494 is a backport of this pull request to the 3.13 branch.

…CLI (pythonGH-130278) --------- Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> (cherry picked from commit 0ff1611) Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>

bedevere-app · 2025-02-24T02:02:54Z

GH-130495 is a backport of this pull request to the 3.12 branch.

… CLI (GH-130278) (#130494) gh-130160: use `.. program::` directive for documenting `idle` CLI (GH-130278) --------- (cherry picked from commit 0ff1611) Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>

… CLI (GH-130278) (#130495) gh-130160: use `.. program::` directive for documenting `idle` CLI (GH-130278) --------- (cherry picked from commit 0ff1611) Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>

pythongh-130160: use .. program:: directive for documenting idle CLI

df3a182

Mr-Sunglasses requested a review from terryjreedy as a code owner February 18, 2025 17:21

bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Feb 18, 2025

bedevere-app bot mentioned this pull request Feb 18, 2025

Use .. program:: and .. option:: directives for modules with a documented CLI #130160

Closed

6 tasks

terryjreedy added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Feb 18, 2025

terryjreedy previously requested changes Feb 20, 2025

View reviewed changes

Doc/library/idle.rst Outdated Show resolved Hide resolved

Doc/library/idle.rst Outdated Show resolved Hide resolved

bedevere-app bot added awaiting changes and removed awaiting review labels Feb 20, 2025

fix: some subcommand and docs

19f6d9c

bedevere-app bot added awaiting change review and removed awaiting changes labels Feb 21, 2025

bedevere-app bot requested a review from terryjreedy February 21, 2025 14:54

Mr-Sunglasses added 3 commits February 21, 2025 20:39

fix: linting errors

147f909

fix: error in the linting

50805d5

fix: error Explicit markup ends without a blank line;

a6c38be

StanFromIreland reviewed Feb 21, 2025

View reviewed changes